Comentarios

Descripcion

Como usar comentarios en el código y como no usarlos.

Comentarios

Conceptos generales:

Evitar usar comentarios

Como norma general el código debería de ser autoexplicativo, por lo tanto el uso de comentarios debería de ser casi inexistente, si necesitamos un comentario para explicar una parte del código probablemente no estemos usando los nombres correcto para las variables y funciones de dicho código.

Comentarios TODO

Podemos usar los comentarios para marcar zonas del código donde queramos realizar cambios, por ejemplo para renombrar ciertas funciones o variables cuyo nombre no nos conveza del todo, podemos dejar un comentario con //TODO, de esta manera para encontrar todos estos sitios en el código solo tenemos que buscar TODO y veremos todos los sitios donde tenemos pendientes cosas por hacer.


No comentar código

Nunca debemos de dejar código comentado, ya que puede ser confuso para otras personas.


No usar comentarios si se puede usar una variable o funcion

Es mejor usar variables intermedías para dar contexto al código y hacer que sea mas explicativo sin necesidad de usar comentarios

Por ejemplo el siguiente código:

int base = 5;
int altura = 6;

System.out.println(base*altura/2); //Imprimir area triangulo

Se podría escribir así:

int base = 5;
int altura = 6;
int areaTriangulo = (base*altura)/2;

System.out.println(areaTriangulo);
Tags

Clean Code | Comentarios